home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 012 / pcedutil.arc / HS.DOC < prev    next >
Text File  |  1986-08-14  |  12KB  |  297 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.           HS (hindsite) command
  8.  
  9.           Purpose
  10.  
  11.           Allows you to look back at certain data that has scrolled off the
  12.           screen.
  13.  
  14.  
  15.           Format 
  16.  
  17.                HS [/Bn] [/Hn] [/Wn] [/An] [/Pn] [/S+|-] [/K]
  18.  
  19.  
  20.           Installation
  21.  
  22.           Hindsite (HS) is installed into PCED as a supplement to PCED's
  23.           keyboard handler.  PCED must be installed before HS.
  24.  
  25.           Install HS by typing
  26.  
  27.                HS <parameterlist>
  28.  
  29.           at the DOS prompt or by including that command in your
  30.           AUTOEXEC.BAT startup batch.  All optional parameters listed above
  31.           are valid at install time except /K.  Parameters are described
  32.           more fully below.
  33.  
  34.  
  35.           Optional Parameters
  36.  
  37.           The optional parameters are as follows:
  38.  
  39.           /B   Buffer: sets the size of the buffer HS uses to store
  40.                scrolled-off data.  The buffer defaults to 4000 characters,
  41.                but you can set any size from 100 to 32000 characters via
  42.                the /B parameter.  For example, to install HS with an 8000
  43.                character buffer:
  44.  
  45.                     HS /B8000
  46.  
  47.                The /B parameter is valid ONLY at the time HS is installed;
  48.                it cannot be changed after installation.
  49.  
  50.           /H   Height: defines the maximum height of the screen, in lines. 
  51.                Normal screen height is 25 lines (which is the default), but
  52.                certain video adapters allow "taller" screens.  For example,
  53.                IBM's Enhanced Graphics Adapter (EGA) can generate screens
  54.                that are 43 lines high.  To instruct HS to reserve
  55.                sufficient storage for a 43-line EGA screen:
  56.  
  57.                     HS /H43
  58.  
  59.                HS will only accept values from 25 to 50 for screen height. 
  60.  
  61.  
  62.  
  63.  
  64.  
  65.           HS (hindsite) command
  66.  
  67.                The /H parameter is valid ONLY at the time HS is installed;
  68.                it cannot be changed after installation.
  69.  
  70.           /W   Width: defines the maximum width of the screen, in columns. 
  71.                Normal screen width is 80 columns (which is the default),
  72.                but certain video adapters allow "wider" screens.  For
  73.                example, some adapters can generate screens that are 132
  74.                columns "wide".  To instruct HS to reserve sufficient
  75.                storage for a 132-column screen:
  76.  
  77.                     HS /W132
  78.  
  79.                HS will only accept values from 80 to 150 for screen width. 
  80.                The /W parameter is valid ONLY at the time HS is installed;
  81.                it cannot be changed after installation.
  82.  
  83.           /A   Attribute: defines the video attribute (color) that HS will
  84.                use in displaying scrolled off data.  The default attribute
  85.                is 7 (normal intensity white on black).  To change the
  86.                attribute to yellow on blue (color 30):
  87.  
  88.                     HS /A30
  89.  
  90.                You can respecify the /A attribute as often as you wish.
  91.  
  92.           /P   Prompt attribute: defines the video attribute (color) that
  93.                HS will use in displaying its prompt.  The default attribute
  94.                is 15 (high intensity white on black).  To change the
  95.                attribute to blue on yellow (color 97):
  96.  
  97.                     HS /A97
  98.  
  99.                You can respecify the /P attribute as often as you wish.
  100.  
  101.           /S   Synchronization: with display adapters other than
  102.                monochrome, HS normally waits for a video retrace to occur
  103.                before writing to the screen.  This prevents "snow" on
  104.                standard Color Graphics Adapters, but it slows down HS's
  105.                display speed.  Some newer adapters (including IBM's EGA) do
  106.                not need this "synchronization", and HS can be made to run
  107.                faster by suppressing synchronization.
  108.  
  109.                The /S parameter has two formats:
  110.  
  111.                     /S+  Synchronize on retrace (slow)
  112.                     /S-  No synchronize on retrace (fast)
  113.  
  114.                If you have a "snowless" adapter or if you don't care about
  115.                snow, you can make HS run faster as follows:
  116.  
  117.                     HS /S-
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.           HS (hindsite) command
  125.  
  126.                The /S parameter can be respecified as often as you wish. 
  127.                It has no effect on the monochrome adapter, which is always
  128.                set to /S-.
  129.  
  130.           /K   Kill: issue the command "HS /K" if you wish to remove HS
  131.                from memory entirely.  In some cases it may not be possible
  132.                for this to be done safely; HS will tell you so if this
  133.                occurs.  The /K parameter is not valid at install time.
  134.  
  135.  
  136.           Operation
  137.  
  138.           After HS has been installed, you can "scroll back" and view data
  139.           that has disappeared off the top of the screen by pressing the
  140.           <PgUp> key at the DOS prompt or in PCED-compatible programs such
  141.           as DEBUG or EDLIN.  Once in the scrollback view, the following
  142.           keys are active:
  143.  
  144.                <Up>      Scroll the view one line toward the "top" of the
  145.                          buffer (oldest data).
  146.  
  147.                <Down>    Scroll the view one line toward the "bottom" of
  148.                          the buffer (newest data).
  149.  
  150.                <PgUp>    Scroll the view one "page" toward the top of the
  151.                          buffer.
  152.  
  153.                <PgDn>    Scroll the view one page toward the bottom of the
  154.                          buffer.
  155.  
  156.                <Home>    Scroll the view all the way to the top--view the
  157.                          oldest data in the buffer.
  158.  
  159.                <End>     Scroll the view all the way to the bottom--view
  160.                          the newest data.
  161.  
  162.                <Esc>     Return to normal operation.
  163.  
  164.  
  165.           Remarks
  166.  
  167.           1. General design considerations
  168.  
  169.           Hindsite is designed as a "DOS level" backscroll program.  That
  170.           is, its primary purpose is to capture text that has been sent to
  171.           the screen by DOS commands (such as DIR) and simple
  172.           non-interactive programs, and to allow you easily review this
  173.           data at the DOS prompt.  Two primary design considerations were
  174.           to make HS small (the size of the resident portion of HS is just
  175.           2K bytes, plus buffer space), and to have as little effect as
  176.           possible on screen speed during normal system operation.
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.           HS (hindsite) command
  184.  
  185.           For these reasons, HS captures ONLY data that has been sent to
  186.           the screen using standard DOS functions.  It does NOT attempt to
  187.           capture data from programs that either write information directly
  188.           to screen memory, or use BIOS functions for screen output.  It is
  189.           our feeling that most such programs have no need of a backscroll
  190.           facility, and that providing such a facility where none is needed
  191.           would greatly increase the size and complexity of the program.  
  192.           Examples of programs that do not need backscroll capabilities are
  193.           spreadsheets, word processors and text editors, and most
  194.           communications programs.
  195.  
  196.           You will find, however, that HS is quite useful in that it
  197.           captures information from all DOS commands and programs (DIR,
  198.           TREE, CHKDSK, DEBUG, EDLIN, LINK, MASM etc.) and from many user-
  199.           supplied programs as well.  Most non-interactive utility- and
  200.           system-oriented programs are fully compatible with HS, notable
  201.           exceptions being those that were compiled using Turbo Pascal's
  202.           default BIOS mode. (Not to editorialize, but this is the 163rd
  203.           reason why we think that most TP utilities should be compiled to
  204.           use DOS, rather than BIOS, for output.)
  205.  
  206.  
  207.           2. Availability 
  208.  
  209.           HS backscroll is available whenever PCED is "active" as defined
  210.           in your PCED manual (page 4).  For most purposes, this means "at
  211.           the DOS prompt".  However, HS is also available at the DEBUG and
  212.           EDLIN prompts, and from within other PCED-compatible programs.
  213.  
  214.  
  215.           3. Screen size
  216.  
  217.           The /H and /W parameters allow HS to determine the maximum amount
  218.           of memory it will need in order to save the "live" screen when
  219.           backscrolling is invoked.  They do NOT cause the actual screen
  220.           mode to be altered.  Thus, for example, a /H43 parameter does not
  221.           cause backscrolls to be displayed in 43 line mode.  In order to
  222.           see 43-line backscrolls, you must already be in 43-line mode when
  223.           you press <PgUp>.
  224.  
  225.  
  226.           4. Other PCED keyboard drivers
  227.  
  228.           If you use another PCED keyboard driver, load it before Hindsite. 
  229.           HS will call your driver for input when necessary.
  230.  
  231.  
  232.           5. Technical information
  233.  
  234.           HS stores only characters (no attributes).  Backscroll display
  235.           attributes are determined by the /A and /P parameters.
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.           HS (hindsite) command
  243.  
  244.           HS does not necessarily store 80 characters per line; only data
  245.           actually output is stored.  A blank line, for example, only
  246.           requires one byte of storage.  Also, trailing blanks at the end
  247.           of a line are not stored.  Thus, the number of "pages" of
  248.           scrolled data available for viewing will vary.
  249.  
  250.           ANSI sequences that could result in cursor movement are
  251.           interpreted as carriage returns.
  252.  
  253.           Carriage returns are always assumed to signify the beginning of a
  254.           CR/LF sequence.  LF's following carriage returns are ignored.
  255.  
  256.           LF's following anything other than CR's are interpreted as CR's
  257.           (hence, from above, as CR/LF's).
  258.  
  259.           HS attempts to make backscrolling more "efficient" in terms of
  260.           screen use by suppressing the third and all following consecutive
  261.           carriage returns.
  262.  
  263.           A backspace results in the deletion of the last character in the
  264.           buffer unless the last character is a carriage return.
  265.  
  266.           Lines wider than the defined maximum screen width (default 80
  267.           characters) will automatically wrap.
  268.  
  269.           HS recognizes the following, and ONLY the following, DOS
  270.           functions as console output:
  271.  
  272.                     02H  Output char in DL
  273.                     06H  Output char in DL iff DL < 255
  274.                     09H  Output '$' terminated string at DS:DX
  275.                     40H  Output CX characters from DS:DX.  HS only cares
  276.                          about handles 1 (stdout) and 2 (stderr).
  277.  
  278.           HS picks up the number of screen rows from the EGA-documented
  279.           byte at 40H:84H.  If this byte is zero, 25 rows are assumed.
  280.  
  281.                                   * * * * * * * * *
  282.  
  283.           IBM is a registered trademark of International Business Machines. 
  284.           Turbo Pascal is a trademark of Borland International, Inc.  PCED
  285.           is a trademark of the Cove Software Group.
  286.  
  287.  
  288.                                 Copyright (c) 1986 by
  289.                                The Cove Software Group
  290.                                 Post Office Box 1072
  291.                               Columbia, Maryland 21044
  292.                                     301-992-9371
  293.                                  ALL RIGHTS RESERVED
  294.  
  295.           hs 1.02/cjd 860814
  296.  
  297.